home *** CD-ROM | disk | FTP | other *** search
/ Maximum CD 1999 November / maximum-cd-1999-11.iso / Utilities / Automation / WinWizard Pro / README.TXT < prev    next >
Encoding:
Text File  |  1999-03-03  |  34.0 KB  |  698 lines

  1. Program Development Systems, Inc.
  2. "An Easy Way to Automate Your PC..."
  3.  
  4. Please visit us at www.pdssoft.com for the latest information on this shareware software utility.
  5. (Ordering information is also available on line.)
  6.  
  7. WinWizard Pro Version 2.0 R33
  8.  
  9. INSTALLATION:
  10.  
  11. Unzip the accompanying zip file using a standard "pkunzip" utility to a new folder for installation. Once the installation files are unzipped, run the SETUP.EXE and follow the on screen directions to complete the install.
  12.  
  13. USING THE APPLICATION:
  14.  
  15. The Status Window allows you to Open, Run, Pause and Stop a Script File.  The Display Window is used to display user information for feedback during script processing.  A script file may only be RUN from this window and MUST be saved in the editor prior to running.
  16.  
  17. The WinWizard Pro Editor allows you to create script files for processing.  You may open and save script files here as well as writing them.   When creating a new script file, the {EXIT} command will automatically be entered in the blank script file and you may begin editing from there.
  18.  
  19. Once command lines are entered into the Editor, you may Insert, Delete, Edit and Move the command lines.  Double-Clicking on a line will display the Line Editor Window which will assist you in creating the command line, however, if you wish to edit the command line directly, you may click once on the line, then press the F2 key. This will allow you to edit a line using the standard editing features of Windows.
  20.  
  21. If you double-click on a line or press the "edit" button (or the "insert" button), the Command Line Editor will display allowing you to modify a line.  You may select a command from the Script Command Drop Down List, all commands are located here and make it easy to create scripts.
  22.  
  23. The Parameters line is where the additional information from the command will be entered. In the example above, since the {DISPLAYADD} command was selected, the message to be displayed should be entered on the Parameter line.   Commands such as {FLOAT} or {ACTIVATE} will present a list in the Parameter Drop Down List so writing script files becomes easier.
  24. For Example: Selecting {FLOAT} from the Script Command Drop Down List will place "ON" and "OFF" in the Parameter Drop Down List.  Therefore you need only select the Drop Down Button to finish the Command Line.
  25. If {ACTIVATE} is selected, the Parameter Drop Down List will contain a list of all available processes so finishing the command is as easy as selecting from the list.
  26.  
  27. The "Browse" button may be utilized with commands such as {RUN} where a disk file name and path are required.  When Browse is selected, a standard Windows Open Dialog box will appear and you may select the file name you wish to process. When you click "OK" in the Open Dialog Box, the file you selected will appear on the "Parameters" line.
  28.  
  29. Selecting the Variable List Drop Down Menu will allow you to select Variables to insert in your command line.  Once the variable is selected, it will automatically be inserted into the Parameter Line. NOTE: If you use the ARROW keys to move from variable to variable, each one will be inserted onto the Parameter Line.  The Variable Selection is best utilized with the mouse.   Once your command line is finished, clicking the "OK" button will return you to the Editing Window and the current command line will correspond to your changes.
  30.  
  31. The WinWizard Pro Process Window allows you to display the available processes that are running, this may be used to find a process title when using the {ACTIVATE} command.  This window will also display if the {PROCESS} command is encountered during script file execution.  This may be useful for finding the process title of a program while you are testing your script file.
  32.  
  33. WinWizard Pro works by writing script or batch files utilizing the following series of commands.  Each command line may only contain one command function and the command line must follow the appropriate syntax.   Several "Sample" script files accompanied the WinWizard Pro download and may be used as a guide in creating your own script files.
  34. This page is kept "up to date" with the most recent command reference structure.  You may wish to print this page and retain it with your WinWizard Program.  Also, check back here regularly for updates or modifications in the command structure.
  35.  
  36. Command Reference:
  37.  
  38. ACTIVATE
  39.  
  40. Syntax:
  41. {ACTIVATE} ProcessTitle
  42. Description:
  43. Activates the designated Process so that keystrokes may be sent to it. ProcessTitle must match the Window Title Bar exactly for this command to work.
  44. Example:
  45. {ACTIVATE} Microsoft Word - Document1
  46.  
  47. The above example will activate the "Microsoft Word - Document1" window and prepare it so that the script file can send keystrokes to it.
  48. Comments:
  49. This command allows you the capability to control a program by sending keystrokes to it with the {TYPE} command. In some cases, the Program may automatically become active when you {RUN} it, in this event you may not need to use the {ACTIVATE} command.
  50.  
  51. AUTO
  52.  
  53. Syntax:
  54. {AUTO} CheckInterval, ScriptFileName
  55. Description:
  56. Checks to see if the ScriptFileName exists in the proper Path every CheckInterval minutes. If the ScriptFileName exists, it will automatically be executed.
  57. Example:
  58. {AUTO} 5, c:\myfolder\testfile.wzd 
  59.  
  60. The above example will automatically execute the "c:\myfolder\testfile.wzd" file when it is found on the system. It will check to see if this file exists every 5 minutes.
  61. Comments:
  62. This command is intended to allow a Systems Administrator to automatically update workstations by copying a file to a pre-designated location on the end user's hard drive or network drive. When the end user's computer sees the script file, it can automatically execute the script file. When the new script file is complete, the last command could delete the script file preventing it from starting again.
  63.  
  64. CALC
  65.  
  66. Syntax:
  67. {CALC} Calculation 
  68. {CALC0} Calculation, {CALC1} Calculation, à {CALC9} Calculation
  69. Description:
  70. Performs a simple calculation and stores the results in {VARIABLE}. {CALC0-9} are stored in the values {VARIABLE0-9}. 
  71. Example:
  72. {CALC} 10 + 10 + 10
  73.  
  74. The above example will calculate and store the result of 30 in the variable named {VARIABLE}
  75. Comments:
  76. Although this command will only perform simple calculations using "+", "-", "*" and "/" (Addition, Subtraction, Multiplication and Division) it can still be very useful to the script developer. You may also use VARIABLES in the calculation. The following command is valid and will store the result in {VARIABLE2}: {CALC2} {VARIABLE} + {VARIABLE3} * 100. 
  77. Note: The {CALC} and {CALC0-9} commands calculate from left to right only and you may not use parenthesis in your calculation.
  78.  
  79. CANCEL
  80.  
  81. Syntax:
  82. {CANCEL} Message
  83. Description:
  84. Allows the end user to continue or cancel the script file execution.
  85. Example:
  86. {CANCEL} Would you like to continue running this script file?
  87.  
  88. The above example will display a dialog window allowing the user the option to continue or cancel the script. If the user selects the cancel button, the script file will end and no other options are allowed. If the user continues, the script will proceed from there.
  89. Comments:
  90. This command gives the end user a chance to abort a script file or simply allows the script file to wait for the end user to approve an operation. For example: {CANCEL} Insert a diskette in the floppy drive and select OK. This command will halt script execution until the end user is ready and selects the OK button.
  91.  
  92. CLIPAPPEND
  93.  
  94. Syntax:
  95. {CLIPAPPEND} FileName
  96. Description:
  97. Appends, or adds, the contents of the clipboard to the existing FileName. The path must be included with FileName and only text information may be used.
  98. Example:
  99. {CLIPAPPEND} c:\data\clipdata.txt
  100.  
  101. In the above example, the contents of the clipboard will be added to the file c:\data\clipdata.txt.
  102. Comments:
  103. This command allows the clipboard to be added to an existing file. With this command, the script can continually save information to a file so that the resulting file will hold all of the information copied.
  104.  
  105. CLIPLOAD
  106.  
  107. Syntax:
  108. {CLIPLOAD} FileName
  109. Description:
  110. Loads the contents of a file onto the clipboard. The path must be included with FileName and only text information may be used.
  111. Example:
  112. {CLIPLOAD} c:\data\testdata.txt
  113.  
  114. In the above example, the contents of the file c:\data\testdata.txt will be placed on the clipboard.
  115. Comments:
  116. This command allows you to place existing information onto the clipboard for "pasting" into an application or appending to another file with the CLIPAPPEND command.
  117.  
  118. CLIPSAVE
  119.  
  120. Syntax:
  121. {CLIPSAVE} FileName
  122. Description:
  123. Saves the contents of the clipboard to a file. The path must be included with FileName and only text information may be used.
  124. Example:
  125. {CLIPSAVE} c:\data\clipdata.txt
  126.  
  127. In the above example, the contents of the clipboard are saved to the c:\data\clipdata.txt file.
  128. Comments:
  129. This command allows you to save the clipboard information for later use. Unlike the CLIPAPPEND command, the CLIPSAVE will erase any existing information in a file.
  130.  
  131. CLIPSET
  132.  
  133. Syntax:
  134. {CLIPSET} TextString
  135. Description:
  136. Places the designated text information on the clipboard. Only text information may be used.
  137. Example:
  138. {CLIPSET} This report was started on {DATE} at {TIME}
  139.  
  140. In the above example, the clipboard will contain the data "This report was started on 11-25-1999 at 10:00:54" (the current date and time).
  141. Comments:
  142. With this and the other Clipboard commands you should be able to manipulate the clipboard to assist you in almost any clipboard handling script. The above example could be used to build a Log File of your script processes.
  143.  
  144. COPY
  145.  
  146. Syntax:
  147. {COPY} SourceFile {TO} DestinationFile
  148. Description:
  149. Copies a file to a new name and/or location. Wildcards may NOT be used and the files must contain full paths.
  150. Example:
  151. {COPY} c:\autoexec.bat {TO} c:\backup\autoexec.bat
  152.  
  153. The above example will copy the c:\autoexec.bat file to the c:\backup\autoexec.bat folder and file.
  154. Comments:
  155. Although you may elect to write a DOS Batch file to perform much of your copying needs, this command allows an easy way to incorporate it into your script files.
  156.  
  157. DISPLAY
  158.  
  159. Syntax:
  160. {DISPLAY} Message
  161. Description:
  162. Displays a Message in the WinWizard Display Window, No Message will clear the display window.
  163. Example:
  164. {DISPLAY} This script file will install the Corporate Logo onto your system.
  165.  
  166. In this example, the display window of the WinWizard Program will display "This script file will install the Corporate Logo onto your system".
  167. Comments:
  168. This command allows you to give feedback to the end user. You can change the message as the script processes to show the current status of your script file.
  169.  
  170. DISPLAYADD
  171.  
  172. Syntax:
  173. {DISPLAYADD} Message
  174. Description:
  175. Displays a Message in the WinWizard Display Window without clearing any previously displayed information.
  176. Example:
  177. {DISPLAYADD} This script will now copy some files to the Server.
  178.  
  179. In this example, the display window of the WinWizard Program will include the above message without erasing any other message in the display.
  180. Comments:
  181. This command allows you to display a list of information to the end user so that they may be able to see all of the steps which have completed in your script file. This may also be used to designate paragraphs in the display window since each new DISPLAYADD command starts on a new line.
  182.  
  183. DO
  184.  
  185. Syntax:
  186. {DO} NumberOfLoops
  187. Description:
  188. Part of a DO/LOOP Command which creates a LOOP similar to the BASIC Programming Language. If you include NumberOfLoops, you will simulate a FOR/NEXT loop and the LOOP will cycle NumberOfLoops times.
  189. Example:
  190. {DO} 100
  191.  
  192. The example above will start a DO/LOOP which will cycle 100 times. Any command lines between the {DO} and {LOOP} will process for all cycles.
  193. Comments:
  194. The {DO} and {LOOP} commands allow you to repeat steps in a script file. You may use a variable in place of NumberOfLoops but unlike a BASIC FOR/NEXT command, the variable will not update as the loop continues. You would instead have to use a {CALC} command to keep track of the current cycle. (i.e. {CALC5} {VARIABLE5} + 1). If NumberOfLoops is omitted, the DO/LOOP Statement will cycle indefinitely or until an EXITDO statement is encountered.
  195.  
  196. END
  197.  
  198. Syntax:
  199. {END}
  200. Description:
  201. Terminates the script file but does not close the WinWizard Program.
  202. Example:
  203. {END}
  204.  
  205. In the above example, the script file ends.
  206. Comments:
  207. The END command is used primarily during script development so that when the script file completes, the WinWizard Program will still stay open. Normally, you will wish to change the END command to an EXIT command once the script file is tested and ready for production.
  208.  
  209. ERASE
  210.  
  211. Syntax:
  212. {ERASE} FileName
  213. Description:
  214. Erases the designated file from the designated path and drive. The file name and path are required for this command. You may NOT use wildcards in FileName.
  215. Example:
  216. {ERASE} c:\test\data\mytestdata.txt
  217.  
  218. In the above example, the c:\test\data\mytestdata.txt file will be deleted.
  219. Comments:
  220. As with the COPY Command, when erasing multiple files it may be more practical to create a DOS Batch file. However, this command allows an easy script method to perform a file delete.
  221.  
  222. EXIT
  223.  
  224. Syntax:
  225. {EXIT}
  226. Description:
  227. Terminates a script file and closes the WinWizard Program.
  228. Example:
  229. {EXIT}
  230.  
  231. The above example causes the script file to terminate and closes the WinWizard Program.
  232. Comments:
  233. When WinWizard is processing a script file and it reaches the end of the script or the beginning of a sub-routine, WinWizard will automatically terminate the script and exit the program. However, the EXIT command was developed to primarily show "program flow" when reading and editing the script file. Whenever you begin a new script file using the built in script editor, the EXIT command will automatically be entered.
  234.  
  235. EXITDO
  236.  
  237. Syntax:
  238. {EXITDO}
  239. Description:
  240. Causes script execution to exit a DO/LOOP statement.
  241. Example:
  242. {EXITDO}
  243.  
  244. In the above example, when the EXITDO statement is reached, it will end the previously assigned DO/LOOP cycle.
  245. Comments:
  246. Unless you are using the NumberOfLoops option in a DO/LOOP command, you may wish to exit the DO/LOOP statement should a certain condition be met. The EXITDO statement will override the NumberOfLoops option in the DO Command.
  247.  
  248. FLOAT
  249.  
  250. Syntax:
  251. {FLOAT} On/Off
  252. Description:
  253. When turned on, causes the WinWizard Program to "float" on top of any other window in the display area even if it is not the active window.
  254. Example:
  255. {FLOAT} On
  256.  
  257. The above example turns the "windows on top" (float) option on.
  258. Comments:
  259. You may wish to use this command when displaying feedback to the end user through the DISPLAY and DISPLAYADD commands without having the information covered by any other applications. Using the FLOAT command while running the Windows Task Manager or other programs which "float" may cause system problems.
  260.  
  261. HOLD
  262.  
  263. Syntax:
  264. {HOLD} ProcessTitle
  265. Description:
  266. Halts script execution until the designated ProcessTitle ends.
  267. Example:
  268. {HOLD} Microsoft Windows - Document1
  269.  
  270. The above example will halt script execution until the "Microsoft Windows - Document1" process terminates.
  271. Comments:
  272. The HOLD Command allows the script file to pause while a program may be running or exiting. Once the program is closed, the script will continue. The ProcessTitle may be other processes besides an actual Windows Program. You may check the Process List of the WinWizard Program to display the currently running processes that can be used in the HOLD Command.
  273.  
  274. IF
  275.  
  276. Syntax:
  277. {IF} Condition {THEN} SubRoutine
  278. Description:
  279. Allows the script file to test for a certain Condition. If the Condition passes, the SubRoutine will be launched. The IF command is designed to test Text Character Strings.
  280. Example:
  281. {IF} {VARIABLE1} = Hello World {THEN} RunSayHello
  282.  
  283. In the above example, if the value of VARIABLE1 is equal to "Hello World", the RunSayHello sub-routine will begin processing. The sub-routine will return to the line following this IF Statement.
  284. Comments:
  285. The IF/THEN Statement allows you to check for certain conditions during script execution and act on them by redirecting the script to a sub-routine. When the sub-routine finishes, it returns to the line following the original IF Statement. The IF Command is primarily geared toward comparing for Text String values, the IFVAL, IFEXISTS and IFTASK commands may be used for other comparisons. The IF statement my ONLY result in a jump to a sub-routine (similar to a BASIC IF/THEN/GOSUB command).
  286.  
  287. IFEXISTS
  288.  
  289. Syntax:
  290. {IFEXISTS} FileName = TRUE/FALSE {THEN} SubRoutine
  291. Description:
  292. Allows the script file to check if a certain file exists on the system. Based on the result of TRUE or FALSE, the SubRoutine may be launched. The IFEXISTS command is designed to check for disk files, drives and full paths should be included.
  293. Example:
  294. {IFEXISTS} c:\autoexec.bat = FALSE {THEN} CreateAutoexecFile
  295.  
  296. In the above example, the script file checks to see if the c:\autoexec.bat file exists. In this case, if it does not, the CreateAutoExecFile sub-routine is performed.
  297. Comments:
  298. The IFEXISTS command allows you to check for a disk file, you can then take action based on the results TRUE or FALSE. If the TRUE/FALSE condition is met, the sub-routine will be launched and script execution will continue on the line following this one when the sub-routine completes. The IF statement my ONLY result in a jump to a sub-routine (similar to a BASIC IF/THEN/GOSUB command).
  299.  
  300. IFTASK
  301.  
  302. Syntax:
  303. {IFTASK} ProcessTitle = TRUE/FALSE {THEN} SubRoutine
  304. Description:
  305. Allows the script file to check if a certain process is active. Based on the result TRUE or FALSE, the SubRoutine may be launched.
  306. Example:
  307. {IFTASK} Microsoft Windows - Document1 = TRUE {THEN} TypeSomeText
  308.  
  309. In the above example, if the "Microsoft Windows - Document1" appears on the Process List, the TypeSomeText sub-routine will be launched.
  310. Comments:
  311. Similar to a HOLD or WAIT command, the IFTASK command allows you to take some action based on the condition of a certain process. A simple use of this command would be to check if a program is already running prior to running it. The IF statement my ONLY result in a jump to a sub-routine (similar to a BASIC IF/THEN/GOSUB command). The IFTASK command is designed to check the WinWizard Process List, you may therefore check for any of the items on this list which may not necessarily be Windows Program Titles.
  312.  
  313. IFVAL
  314.  
  315. Syntax:
  316. {IFVAL} Condition {THEN} SubRoutine
  317. Description:
  318. Allows the script file to compare numeric values and act on the results. If the Condition passes, the SubRoutine will be launched.
  319. Example:
  320. {IFVAL} {VARIABLE5} = {VARIABLE6} {THEN} DoTheSubRoutine
  321.  
  322. In the above example, if the Value of VARIABLE5 is equal to the Value of VARIABLE6 then the DoTheSubRoutine will be launched.
  323. Comments:
  324. The IFVAL command is used only to compare numeric values. Even though the VARIABLE values may be text or numeric, the IFVAL command will convert any text it finds to a numeric value which will equal zero and will still try to perform the operation. The IF statement my ONLY result in jump to a sub-routine (similar to a BASIC IF/THEN/GOSUB command).
  325.  
  326. INPUT
  327.  
  328. Syntax:
  329. {INPUT} Message
  330. {INPUT0} Message, {INPUT1} Message à {INPUT9} Message
  331. Description:
  332. Halt script execution and allow the end user to input data. Message indicates the user prompt.
  333. Example:
  334. {INPUT} Enter your name belowà
  335.  
  336. In the above example, a dialog window will appear requesting the end user to "Enter your name belowà". When the user enters the information and clicks the OK button, the data will be stored in {VARIABLE} or {VARIABLE1-9} depending on the INPUT command.
  337. Comments:
  338. This command allows you to accept information from the end user and use it in your script processing. If the user selects the Cancel button, the variable will be null (no value).
  339.  
  340. LOOP
  341.  
  342. Syntax:
  343. {LOOP}
  344. Description:
  345. Part of the DO/LOOP statement which indicates the end of the loop. Once this command is encountered, the script will return to the beginning DO line.
  346. Example:
  347. {LOOP}
  348.  
  349. The above example will cause script processing to resume at the statement following the original DO command.
  350. Comments:
  351. This command completes the DO/LOOP statement and will allow you to generate repeated steps in your script file. The LOOP can be exited using the EXITDO command or if the Number of Loops in the original DO statement have completed.
  352.  
  353. MINIMIZE
  354.  
  355. Syntax:
  356. {MINIMIZE}
  357. Description:
  358. Minimizes the WinWizard window and places it on the task bar.
  359. Example:
  360. {MINIMIZE}
  361.  
  362. The above command minimizes the WinWizard window and places it in the "System Tray" identified by a lightning bolt. The end user may restore the window by double-clicking on the icon.
  363. Comments:
  364. This command is useful for allowing your script to process in the background or while it may be in a "wait state" such as when using the AUTO or START commands.
  365.  
  366. PAUSE
  367.  
  368. Syntax:
  369. {PAUSE}
  370. Description:
  371. Halt script execution and wait for the user to press ENTER, the SPACE BAR or click the RUN button.
  372. Example:
  373. {PAUSE}
  374.  
  375. This example will pause the script file and wait until the user selects to continue. Since the RUN button is selected by default, the end user may press the ENTER key, the SPACE BAR or may click on the RUN button to continue the script.
  376. Comments:
  377. Occasionally you may wish to use this command during script testing or when you have displayed information in the WinWizard Display window and want to allow the end user time to review it. This command gives a similar result as the CANCEL command or SPLASH command.
  378.  
  379. PLAY
  380.  
  381. Syntax:
  382. {PLAY} WaveFileName
  383. Description:
  384. Plays a .wav file on a multimedia system. The full drive and path should be included in WaveFileName.
  385. Example:
  386. {PLAY} c:\sounds\test.wav
  387.  
  388. In the above example, the wave file c:\sounds\test.wav will play on a multimedia system.
  389. Comments:
  390. The general concept of this command is to allow feedback to the end user. You may wish to record a message and play it to the end user versus displaying it on the screen. For example your wave file might be a talking voice saying "The first operation is completeà Moving to step 2".
  391.  
  392. PROCESS
  393.  
  394. Syntax:
  395. {PROCESS}
  396. Description:
  397. Halt script execution and display the "On Line Process List".
  398. Example:
  399. {PROCESS}
  400.  
  401. The above example stops the currently running script file and displays the active processes in the WinWizard Process window.
  402. Comments:
  403. This command is primarily geared for script testing and finding active processes. You may use this command to find the Process Title of your screen saver. Create a script file that waits or SLEEPS for 5 minutes (or however long your screen saver takes to activate) then have the script file display the PROCESS list. You should then be able to identify the Process Title of your screen saver.
  404.  
  405. PROMPT
  406.  
  407. Syntax:
  408. {PROMPT} Message
  409. Description:
  410. Halt script execution until the end user selects the OK button. Message may contain user feedback.
  411. Example:
  412. {PROMPT} Click OK when Readyà
  413.  
  414. In the above example, the script file displays a dialog window with the message "Click OK when Readyà" and will wait until the user clicks OK.
  415. Comments:
  416. Similar to the CANCEL command, the PROMPT command allows the end user to "catch up", however, it DOES NOT allow the user to cancel the script file.
  417.  
  418. REM
  419.  
  420. Syntax:
  421. {REM} Remark
  422. Description:
  423. Add a Remark to the script file.
  424. Example:
  425. {REM} This portion of the Script will run the accounting program.
  426.  
  427. In this example, a remark or comment line is added to the script file for easier decryption of the script when changes need to be made in the future.
  428. Comments:
  429. Any REM statements encountered by the processing script file will be ignored. This command is only intended to place comments in your script file.
  430.  
  431. RENAME
  432.  
  433. Syntax:
  434. {RENAME} OldFileName {TO} NewFileName
  435. Description:
  436. Rename a disk file. The drive and full path should be included with the OldFileName and NewFileName. No Wildcards may be used.
  437. Example:
  438. {RENAME} c:\data\oldfile.txt {TO} c:\data\newfile.txt
  439.  
  440. The above example renames the file c:\data\oldfile.txt to c:\data\newfile.txt.
  441. Comments:
  442. This command allows you to easily rename disk files through script processing. When renaming files, the complete drive and full path of both old and new file names should be included.
  443.  
  444. RESTORE
  445.  
  446. Syntax:
  447. {RESTORE}
  448. Description:
  449. Restore the WinWizard window to its normal size.
  450. Example:
  451. {RESTORE}
  452.  
  453. This example returns the WinWizard window to its normal screen size from the minimized "System Tray" lightning bolt icon.
  454. Comments:
  455. This command may be used after a MINIMIZE command to restore the WinWizard window or may be used whenever you wish to ensure the window is visible for user feedback.
  456.  
  457. RETURN
  458.  
  459. Syntax:
  460. {RETURN}
  461. Description:
  462. Returns script execution to the line following the calling statement.
  463. Example:
  464. {RETURN}
  465.  
  466. The above example returns script processing to the line following the calling IF statement.
  467. Comments:
  468. This command allows you to return processing to the calling statement. This would follow the same concept as a BASIC GOSUB/RETURN statement. This command is used at the end of a Sub-Routine.
  469.  
  470. RUN
  471.  
  472. Syntax:
  473. {RUN} FileName
  474. Description:
  475. Load and run a windows application. The full drive and path should be included in FileName.
  476. Example:
  477. {RUN} c:\windows\wordpad.exe
  478.  
  479. In the above example, the WordPad program will be loaded and executed.
  480. Comments:
  481. This command allows you to launch a windows program and may usually be followed by the WAIT and ACTIVATE commands.
  482.  
  483. SCRIPT
  484.  
  485. Syntax:
  486. {SCRIPT} ScriptFileName
  487. Description:
  488. Will load and run a new script file. The full drive and path should be included in the ScriptFileName.
  489. Example:
  490. {SCRIPT} c:\scripts\process2.txt
  491.  
  492. In the above example, the c:\scripts\process2.txt script file will be loaded and run through the WinWizard Program.
  493. Comments:
  494. This command allows you to "chain" script files together to create very large processes.
  495.  
  496. SET
  497.  
  498. Syntax:
  499. {SET} Variable = Value
  500. Description:
  501. Sets the Value of a Variable: {VARIABLE}, {VARIABLE0}, {VARIABLE1}, à {VARIABLE9}
  502. Example:
  503. {SET} {VARIABLE5} = 125
  504.  
  505. In the above example, the VARIABLE5 is initialized to the value of 125.
  506. Comments:
  507. This command allows you to initialize variables in your script file for later use. Both numeric and string values may be used.
  508.  
  509. SHUTDOWN
  510.  
  511. Syntax:
  512. {SHUTDOWN} Action
  513. Description:
  514. Will Shutdown, Restart or Reboot the end user personal computer. Where Action is equal to EXIT, RESTART or REBOOT.
  515. Example:
  516. {SHUTDOWN} EXIT
  517.  
  518. The above example will cause Windows to Shutdown and Exit.
  519. Comments:
  520. This command allows you to handle shutdown procedures through Windows. Caution should be used with this command, the end user may not be prompted to save all files prior to the shutdown.
  521.  
  522. SLEEP
  523.  
  524. Syntax:
  525. {SLEEP} Seconds
  526. Description:
  527. Pause script execution for the designated number of Seconds.
  528. Example:
  529. {SLEEP} 5
  530.  
  531. In the example above, the script file will pause for 5 seconds.
  532. Comments:
  533. This command is useful when you which to wait for other processes to complete or want to give the user feedback without requiring them to click the mouse or press a key on the keyboard.
  534.  
  535. SPEED
  536.  
  537. Syntax:
  538. {SPEED} ScriptSpeed
  539. Description:
  540. Defines how fast the script file executes between script commands, 1000 equals approx. 1 Second.
  541. Example:
  542. {SPEED} 2.5
  543.  
  544. In the example above, the script file will pause for approximately 2.5 seconds between each script command line it encounters.
  545. Comments:
  546. This command allows you to speed up or slow down your script file during processing. On slower PCs you may wish to slow the processing speed when sending keystrokes to a program, however, when you are doing internal script processing, you may wish for the script to process as quickly as possible. The lower the value of the script speed, the shorter the delay between command lines. Running a script file too quickly can cause keystrokes to be missed or ignored by the processing program.
  547.  
  548. SPLASH
  549.  
  550. Syntax:
  551. {SPLASH} BitmapFileName
  552. Description:
  553. Display a graphic file splash screen with an OK and Cancel button. The full drive and path should be supplied in BitmapFileName.
  554. Example:
  555. {SPLASH} c:\graphics\splash.bmp
  556.  
  557. In the above example, a window will appear displaying the c:\graphics\splash.bmp graphic file with an OK and Cancel button toward the bottom right of the window and will wait for the end user to select one.
  558. Comments:
  559. This command is a custom version of the CANCEL command, it allows you to customize your script file by adding graphic displays to the end user. Your graphic file splash screen should direct the user to click OK or Cancel and, if the user selects Cancel, the script file will terminate.
  560.  
  561. START
  562.  
  563. Syntax:
  564. {START} StartTime DayofWeek
  565. Description:
  566. Start Script Execution at the designated StartTime and DayOfWeek. StartTime must be entered as Military Time (HH:MM) and DayOfWeek must be MON,TUE,WED,THU,FRI,SAT,SUN,ALL.
  567. Example:
  568. {START} 08:00 MON,WED,FRI
  569.  
  570. In the above example, the script will begin processing on Monday, Wednesday or Friday at 8:00 am.
  571. Comments:
  572. This command allows you to process a script file on a regular daily or weekly schedule. You may not omit the StartTime option however, if DayOfWeek is omitted the script file will assume every day is desired. If you click on the PAUSE button while the script file is in this wait state, the script file will start immediately.
  573.  
  574. SUB
  575.  
  576. Syntax:
  577. {SUB} SubRoutineName
  578. Description:
  579. Define a Sub-Routine within a script file.
  580. Example:
  581. {SUB} ProcessAccounts
  582.  
  583. In the above example, a sub-routine called "ProcessAccounts" has been defined and may be called by an IF statement.
  584. Comments:
  585. Since the IF, IFVAL, IFTASK and IFEXISTS statements can only call a sub-routine, the SUB command allows you the capability to define one. When the sub-routine is called, the script will begin the sub-routine on the line following the SUB command and will return to the calling IF statement when it encounters a RETURN command. Note: During normal script processing, if the script encounters a SUB command when it was not directed to it through an IF statement, the script will assume the file is complete and will terminate.
  586.  
  587. TITLE
  588.  
  589. Syntax:
  590. {TITLE} NewTitleText
  591. Description:
  592. Change the WinWizard Title Bar Text
  593. Example:
  594. {TITLE} Process End of Day
  595.  
  596. In this example, the WinWizard title bar will change to "Process End of Day".
  597. Comments:
  598. Once again, this is another way to customize your script for the end user's feedback.
  599.  
  600. TYPE
  601.  
  602. Syntax:
  603. {TYPE} KeyStrokes
  604. Description:
  605. Will send KeyStrokes to the active application.
  606. Example:
  607. {TYPE} Hello World {ENTER}
  608.  
  609. In this example, the phrase "Hello World" and the ENTER key are sent to the active application.
  610. Comments:
  611. This command allows you to send keystrokes directly to an application. The application must be active, normally accomplished through the ACTIVATE command. As with the previous version of WinWizard, you may omit the TYPE command and you would receive the same results (i.e. Hello World {ENTER}). The use of the TYPE command simply makes editing the script file more comprehendible.
  612.  
  613. WAIT
  614.  
  615. Syntax:
  616. {WAIT} ProcessTitle
  617. Description:
  618. Halts script execution and waits for ProcessTitle to start before continuing on.
  619. Example:
  620. {WAIT} Untitled - Notepad
  621.  
  622. The above example will halt the script file until the "Untitled - Notepad" process appears on the process list, when it does, the script continues.
  623. Comments:
  624. The primary use of this command is to wait until a program is loaded before you send keystrokes to it. When you RUN an application, it may take a few seconds to load and this time may vary from computer to computer. With the WAIT command, the script will simply wait until the designated process is running, then you will be able to send keystrokes. Also, the ProcessTitle must match the program exactly.
  625.  
  626. Special Characters
  627.  
  628. The following characters are considered "Special Characters" to the WinWizard - Script Runner. If you wish to use these characters in your script, they must be enclosed in braces.
  629.  
  630. Special Characters Include: + ^ % ~ ( ) [ ] { }
  631. Coding Examples: {+} {^} {%} {~} {(} {)} {[} {]} {{} {}}
  632.  
  633. Special Key Codes
  634. The following Special Key Codes allow you to send the specific "keystroke" to an application.  These codes are generally associated used with the {TYPE} command. 
  635. {BACKSPACE} Send BACKSPACE Keystroke
  636. {BKSP} Send BACKSPACE Keystroke
  637. {BS} Send BACKSPACE Keystroke
  638. {BREAK} Send BREAK Keystroke
  639. {CAPSLOCK} Toggle CAPSLOCK on and off
  640. {DELETE} Send DELETE Keystroke
  641. {DEL} Send DELETE Keystroke
  642. {DOWN} Send DOWN ARROW Keystroke
  643. {END} Send END Keystroke
  644. {ENTER} Send ENTER Keystroke
  645. {ESC} Send ESCAPE Keystroke
  646. {F1} through {F12} Send FUNCTION KEY Keystroke
  647. {HOME} Send HOME Keystroke
  648. {INSERT} Toggle INSERT mode on and off
  649. {LEFT} Send LEFT ARROW Keystroke
  650. {NUMLOCK} Toggle NUMLOCK on and off
  651. {PGDN} Send PAGEDOWN Keystroke
  652. {PGUP} Send PAGEUP Keystroke
  653. {PRTSC} Send PRINT SCREEN Keystroke
  654. {RIGHT} Send Right Arrow Key
  655. {SCROLLLOCK} Toggle SCROLL LOCK on and off
  656. {TAB} Send TAB Keystroke
  657. {UP} Send UP ARROW Keystroke
  658.  
  659. Special Codes
  660. ~ Send ENTER Keystroke
  661. + Send SHIFT Keystroke 
  662. ^ Send CTRL Keystroke
  663. % Send ALT Keystroke
  664.  
  665. To specify key combinations such as SHIFT and E, enclose the code for those keys in parentheses. Example:
  666.  
  667. SHIFT-E = +(E)
  668. CTRL-X = ^(X)
  669. To repeat common keystrokes such as ARROW DOWN, include a number within braces. Example:
  670.  
  671. PRESS DOWN ARROW 5 TIMES = {DOWN 5}
  672. PRESS THE 'N' KEY 10 TIMES = {N 10} 
  673.  
  674. Note: WinWizard cannot control DOS application and using the {PRTSC} key may not always work.
  675.  
  676. Rules for Writing A Script File
  677.  
  678. All of the WinWizard Commands should appear on a single line, you cannot put multiple commands on a script line. Keystrokes, which are to be sent to an application, may be entered into the script normally. 
  679.  
  680. WinWizard does not send an ENTER keystroke at the end of a line. If you wish to do this, you should enter the line as follows;
  681.  
  682. Enter Some Text into the Program {ENTER}
  683.  
  684. Multiple Special Key Codes may be placed on the same script line, Example;
  685.  
  686. %(E){DOWN 2}{ENTER}
  687.  
  688. The above line will activate the Copy option on an Edit Menu.
  689.  
  690. Special Characters should be enclosed in braces, for example to send the keystrokes;
  691.  
  692. Hello (World)
  693.  
  694. the script should be coded as;
  695.  
  696. Hello {(}World{)}
  697.  
  698.